Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs build #696

Closed
wants to merge 1 commit into from
Closed

Conversation

ianthomas23
Copy link
Contributor

This is a WIP to update the docs build to use a Read the Docs v2 config file. I was originally intending just to fix issue #693 but it turns out that RTD is building on Python 3.7 for which quite a few of the dependencies are a bit old and no longer updated. So this is updating the docs build system to follow a similar approach to fsspec and to fix a variety of doc-related issues at the same time.

@ianthomas23
Copy link
Contributor Author

It seems that in order to test this we would need to alter the RTD Advanced Settings to build on PRs and not just commits to main branch.

@martindurant
Copy link
Member

it turns out that RTD is building on Python 3.7

With the conda env option, we can pick our python version, no?

@martindurant
Copy link
Member

I have enabled PR builds in RTD

@ianthomas23
Copy link
Contributor Author

With the conda env option, we can pick our python version, no?

Yes, we can specify it in the docs/environment.yml that we tell RTD to use.

@martindurant
Copy link
Member

Oh, but I do remember that conda (as opposed to mamba) was using a lot of memory and crashing RTD builds at some point.

@ianthomas23
Copy link
Contributor Author

Oh, but I do remember that conda (as opposed to mamba) was using a lot of memory and crashing RTD builds at some point.

OK, we'll see what happens.

@ianthomas23
Copy link
Contributor Author

RTD hasn't automatically built the docs for this, presumably because the PR had already been created. I'll close this and create another PR to see if that works.

@ianthomas23 ianthomas23 closed this Feb 1, 2023
@ianthomas23 ianthomas23 deleted the read_the_docs_v2 branch February 1, 2023 15:33
@ianthomas23 ianthomas23 restored the read_the_docs_v2 branch February 1, 2023 15:35
@ianthomas23 ianthomas23 deleted the read_the_docs_v2 branch February 1, 2023 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants